post /mint/organizations/{org_name}/billing-adjustments

Makes a billing adjustment for the specified organization.

If you do not specify an optional property, the billing adjustment will be all inclusive for that property. For example, if you do not specify a transaction type, the billing adjustment will apply to all transaction types. See also Making a billing adjustment using the API.

HTTP request

https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments

Path Parameters

org_name (required)

string

Organization name.

Request Body

Billing adjustment.

application/json
BillingAdjustment
adjustmentPercentageFactor (required)

number

Percentage factor by which the bill was adjusted. This value can be positive or negative decimal value to increase or reduce the bill, respectively. Valid values are in the range of -100 to 999.9999.

billingMonth (required)

string

Billing month, specified as an integer. For example, 11 for Decemer.'

billingYear (required)

integer

Billing year, specified using the following format: YYYY. For example, 2017.

developerBillingType

string

Developer billing type for which the billing adjustment applies. Valid values include: PREPAID, POSTPAID, BOTH.

id

string

ID of the billing adjustment. **Required when updating the billing adjustment.

isPublished

boolean

Flag that specifies whether the billing adjustment should be published.

monetizationPackage

object

id

string

ID of the API package.

name (required)

string

Name that describes the billing adjustment.

organization (required)

Organization

approvedTrusted

boolean

Flag that specifies whether the developer is given approved status by the organization.

approvedUntrusted

boolean

Flag that specifies whether untrusted developers are given approved status by the organization.

billingCycle

string

Billing cycle period. Valid values include:

  • PRORATED: Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH: Billing is done monthly.
country

string

ISO 3166-2 code for the country of operation for the organization, such as US for United States or BR for Brazil.

currency

string

ISO 4217 code for the "base" or accounting currency that the organization uses, such as usd for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization.

description

string

Brief description of the organization.

hasBillingAdjustment

boolean

Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products.

hasBroker

boolean

Flag that specifies whether the revenue is based on net.

hasSelfBilling

boolean

Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer.

hasSeparateInvoiceForProduct

boolean

Flag that specifies whether a separate invoice is generated for each API product.

id

string

ID of the organization.

issueNettingStmt

boolean

Flag that specifies whether a netting statement is generated when creating billing documents.

logoUrl

string

URL of the organization's logo.

name

string

Name of the organization.

netPaymentAdviceNote

string

Net payment advice note.

nettingStmtPerCurrency

boolean

Flag that specifies whether a separate netting statement is generated for each currency used.

regNo

string

Organization's registration number. The registration number is displayed at the bottom of billing documents.

selfBillingAsExchOrg

boolean

This feature is deprecated.

selfBillingForAllDev

boolean

If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider.

separateInvoiceForFees

boolean

Flag that specifies whether a separate invoice is published for fees.

status

string

Status of the organization. Valid values include:

  • ACTIVE: The organization account is registered in monetization and is available for use.
  • INACTIVE: The organization account is registered in monetization, but is not available for use.
'
supportedBillingType

string

Developer payment model used for billing. Valid values include:

  • PREPAID: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH: In this case, the billing type defaults to PREPAID.
taxEngineExternalId

string

External ID for a third-party tax engine.

taxModel

string

Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents.

Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:

  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.

  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).

  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.

taxNexus

string

The country in which the organization is registered for tax purposes.

Note: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization.

taxRegNo

string

Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents.

transactionalRelayURL

string

URL of another system to which transactions can be relayed, such as a data warehouse.

timezone

string

The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent.

product

APIProduct

customAtt1Name

string

Custom attribute name. There may be zero or more custom attributes. For example, customAtt1Name, customAtt2Name, customAtt3Name, and so on.

description

string

Description of API product.

displayName

string

User-friendly display name of the API product.

id

string

ID of the API product.

name

string

Name of the API product.

organization

Organization

approvedTrusted

boolean

Flag that specifies whether the developer is given approved status by the organization.

approvedUntrusted

boolean

Flag that specifies whether untrusted developers are given approved status by the organization.

billingCycle

string

Billing cycle period. Valid values include:

  • PRORATED: Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH: Billing is done monthly.
country

string

ISO 3166-2 code for the country of operation for the organization, such as US for United States or BR for Brazil.

currency

string

ISO 4217 code for the "base" or accounting currency that the organization uses, such as usd for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization.

description

string

Brief description of the organization.

hasBillingAdjustment

boolean

Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products.

hasBroker

boolean

Flag that specifies whether the revenue is based on net.

hasSelfBilling

boolean

Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer.

hasSeparateInvoiceForProduct

boolean

Flag that specifies whether a separate invoice is generated for each API product.

id

string

ID of the organization.

issueNettingStmt

boolean

Flag that specifies whether a netting statement is generated when creating billing documents.

logoUrl

string

URL of the organization's logo.

name

string

Name of the organization.

netPaymentAdviceNote

string

Net payment advice note.

nettingStmtPerCurrency

boolean

Flag that specifies whether a separate netting statement is generated for each currency used.

regNo

string

Organization's registration number. The registration number is displayed at the bottom of billing documents.

selfBillingAsExchOrg

boolean

This feature is deprecated.

selfBillingForAllDev

boolean

If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider.

separateInvoiceForFees

boolean

Flag that specifies whether a separate invoice is published for fees.

status

string

Status of the organization. Valid values include:

  • ACTIVE: The organization account is registered in monetization and is available for use.
  • INACTIVE: The organization account is registered in monetization, but is not available for use.
'
supportedBillingType

string

Developer payment model used for billing. Valid values include:

  • PREPAID: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH: In this case, the billing type defaults to PREPAID.
taxEngineExternalId

string

External ID for a third-party tax engine.

taxModel

string

Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents.

Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:

  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.

  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).

  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.

taxNexus

string

The country in which the organization is registered for tax purposes.

Note: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization.

taxRegNo

string

Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents.

transactionalRelayURL

string

URL of another system to which transactions can be relayed, such as a data warehouse.

timezone

string

The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent.

refundSuccessCriteria

string

Expression that is compared to the value of the Status attribute and is used to determine when the refund transaction is successful (for charging purposes). For example: txProviderStatus == 'OK'. Not applicable to POST operations.

status

string

Status indicator for the API product. Valid values include: CREATED, ACTIVE, INACTIVE. This value is maintained but not currently used by the API product.

transactionSuccessCriteria

string

Expression that is compared to the value of the Status attribute and is used to determine when the transaction is successful (for charging purposes). For example: txProviderStatus == 'OK'. Not applicable to POST operations.

transactionType

string

Type of transaction for which the billing adjustment applies. Valid values include: PURCHASE, CHARGE, REFUND, CREDIT, BALANCE, SETUPFEES, TERMINATIONFEES, TRUEUPS. TRUEUPS are transacions that are used to adjust rated transactions; invoked when tax changes are made in the previous month.

Response Types

201: 

Created

Body

application/json
BillingAdjustment
adjustmentPercentageFactor (required)

number

Percentage factor by which the bill was adjusted. This value can be positive or negative decimal value to increase or reduce the bill, respectively. Valid values are in the range of -100 to 999.9999.

billingMonth (required)

string

Billing month, specified as an integer. For example, 11 for Decemer.'

billingYear (required)

integer

Billing year, specified using the following format: YYYY. For example, 2017.

developerBillingType

string

Developer billing type for which the billing adjustment applies. Valid values include: PREPAID, POSTPAID, BOTH.

id

string

ID of the billing adjustment. **Required when updating the billing adjustment.

isPublished

boolean

Flag that specifies whether the billing adjustment should be published.

monetizationPackage

object

id

string

ID of the API package.

name (required)

string

Name that describes the billing adjustment.

organization (required)

Organization

approvedTrusted

boolean

Flag that specifies whether the developer is given approved status by the organization.

approvedUntrusted

boolean

Flag that specifies whether untrusted developers are given approved status by the organization.

billingCycle

string

Billing cycle period. Valid values include:

  • PRORATED: Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH: Billing is done monthly.
country

string

ISO 3166-2 code for the country of operation for the organization, such as US for United States or BR for Brazil.

currency

string

ISO 4217 code for the "base" or accounting currency that the organization uses, such as usd for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization.

description

string

Brief description of the organization.

hasBillingAdjustment

boolean

Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products.

hasBroker

boolean

Flag that specifies whether the revenue is based on net.

hasSelfBilling

boolean

Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer.

hasSeparateInvoiceForProduct

boolean

Flag that specifies whether a separate invoice is generated for each API product.

id

string

ID of the organization.

issueNettingStmt

boolean

Flag that specifies whether a netting statement is generated when creating billing documents.

logoUrl

string

URL of the organization's logo.

name

string

Name of the organization.

netPaymentAdviceNote

string

Net payment advice note.

nettingStmtPerCurrency

boolean

Flag that specifies whether a separate netting statement is generated for each currency used.

regNo

string

Organization's registration number. The registration number is displayed at the bottom of billing documents.

selfBillingAsExchOrg

boolean

This feature is deprecated.

selfBillingForAllDev

boolean

If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider.

separateInvoiceForFees

boolean

Flag that specifies whether a separate invoice is published for fees.

status

string

Status of the organization. Valid values include:

  • ACTIVE: The organization account is registered in monetization and is available for use.
  • INACTIVE: The organization account is registered in monetization, but is not available for use.
'
supportedBillingType

string

Developer payment model used for billing. Valid values include:

  • PREPAID: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH: In this case, the billing type defaults to PREPAID.
taxEngineExternalId

string

External ID for a third-party tax engine.

taxModel

string

Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents.

Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:

  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.

  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).

  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.

taxNexus

string

The country in which the organization is registered for tax purposes.

Note: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization.

taxRegNo

string

Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents.

transactionalRelayURL

string

URL of another system to which transactions can be relayed, such as a data warehouse.

timezone

string

The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent.

product

APIProduct

customAtt1Name

string

Custom attribute name. There may be zero or more custom attributes. For example, customAtt1Name, customAtt2Name, customAtt3Name, and so on.

description

string

Description of API product.

displayName

string

User-friendly display name of the API product.

id

string

ID of the API product.

name

string

Name of the API product.

organization

Organization

approvedTrusted

boolean

Flag that specifies whether the developer is given approved status by the organization.

approvedUntrusted

boolean

Flag that specifies whether untrusted developers are given approved status by the organization.

billingCycle

string

Billing cycle period. Valid values include:

  • PRORATED: Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH: Billing is done monthly.
country

string

ISO 3166-2 code for the country of operation for the organization, such as US for United States or BR for Brazil.

currency

string

ISO 4217 code for the "base" or accounting currency that the organization uses, such as usd for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used by default. However, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization.

description

string

Brief description of the organization.

hasBillingAdjustment

boolean

Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products.

hasBroker

boolean

Flag that specifies whether the revenue is based on net.

hasSelfBilling

boolean

Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer.

hasSeparateInvoiceForProduct

boolean

Flag that specifies whether a separate invoice is generated for each API product.

id

string

ID of the organization.

issueNettingStmt

boolean

Flag that specifies whether a netting statement is generated when creating billing documents.

logoUrl

string

URL of the organization's logo.

name

string

Name of the organization.

netPaymentAdviceNote

string

Net payment advice note.

nettingStmtPerCurrency

boolean

Flag that specifies whether a separate netting statement is generated for each currency used.

regNo

string

Organization's registration number. The registration number is displayed at the bottom of billing documents.

selfBillingAsExchOrg

boolean

This feature is deprecated.

selfBillingForAllDev

boolean

If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider.

separateInvoiceForFees

boolean

Flag that specifies whether a separate invoice is published for fees.

status

string

Status of the organization. Valid values include:

  • ACTIVE: The organization account is registered in monetization and is available for use.
  • INACTIVE: The organization account is registered in monetization, but is not available for use.
'
supportedBillingType

string

Developer payment model used for billing. Valid values include:

  • PREPAID: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH: In this case, the billing type defaults to PREPAID.
taxEngineExternalId

string

External ID for a third-party tax engine.

taxModel

string

Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents.

Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:

  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.

  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).

  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.

taxNexus

string

The country in which the organization is registered for tax purposes.

Note: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization.

taxRegNo

string

Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents.

transactionalRelayURL

string

URL of another system to which transactions can be relayed, such as a data warehouse.

timezone

string

The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent.

refundSuccessCriteria

string

Expression that is compared to the value of the Status attribute and is used to determine when the refund transaction is successful (for charging purposes). For example: txProviderStatus == 'OK'. Not applicable to POST operations.

status

string

Status indicator for the API product. Valid values include: CREATED, ACTIVE, INACTIVE. This value is maintained but not currently used by the API product.

transactionSuccessCriteria

string

Expression that is compared to the value of the Status attribute and is used to determine when the transaction is successful (for charging purposes). For example: txProviderStatus == 'OK'. Not applicable to POST operations.

transactionType

string

Type of transaction for which the billing adjustment applies. Valid values include: PURCHASE, CHARGE, REFUND, CREDIT, BALANCE, SETUPFEES, TERMINATIONFEES, TRUEUPS. TRUEUPS are transacions that are used to adjust rated transactions; invoked when tax changes are made in the previous month.

Authentication Requirements

Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
org_name
Request body
For suggestions, press control+space or click one of the blue "add" circles.
Credentials
Multi-factor authentication is not supported.